Skip to content

Adding Maintaining GhostBSD Ports from FreeBSD Ports#85

Merged
ericbsd merged 2 commits intomasterfrom
maintaining-ports
Apr 6, 2025
Merged

Adding Maintaining GhostBSD Ports from FreeBSD Ports#85
ericbsd merged 2 commits intomasterfrom
maintaining-ports

Conversation

@ericbsd
Copy link
Member

@ericbsd ericbsd commented Apr 5, 2025 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Add documentation for maintaining GhostBSD ports in sync with FreeBSD ports, including a comprehensive guide for contributors on how to update and manage the ports tree.

New Features:

  • Created a new documentation guide for maintaining GhostBSD ports
  • Added a new ports contribution documentation section

Enhancements:

  • Updated dark mode CSS to improve admonition styling
  • Adjusted documentation tree depth and structure in index files

Documentation:

  • Added a new documentation section for ports maintenance with a detailed guide on syncing GhostBSD ports with FreeBSD ports
  • Updated index files to include new ports documentation section
  • Modified Sphinx configuration to improve documentation structure

Chores:

  • Updated requirements.txt
  • Modified Sphinx configuration extensions

@ericbsd ericbsd requested review from a team as code owners April 5, 2025 18:45
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 5, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request adds documentation for maintaining GhostBSD ports in sync with FreeBSD ports, updates documentation index files, and improves the documentation configuration.

Flow diagram for maintaining GhostBSD ports

graph LR
    A[Clone GhostBSD ports] --> B(Add FreeBSD remote)
    B --> C{Fetch FreeBSD changes}
    C --> D{Merge FreeBSD/master}
    D -- Conflicts? --> E{Resolve conflicts}
    D -- No conflicts --> F{Test ports tree}
    E --> F
    F --> G{Commit changes}
    G --> H{Push to branch}
    H --> I{Submit pull request}
    I --> J(Await review and approval)
Loading

File-Level Changes

Change Details Files
Added documentation for maintaining GhostBSD ports in sync with FreeBSD ports.
  • Created a new markdown file detailing the process of keeping the GhostBSD ports tree up-to-date with the FreeBSD ports tree.
  • The documentation covers cloning repositories, configuring remotes, creating working branches, fetching and merging changes, resolving conflicts, testing, and submitting changes.
  • It also includes tips for resolving common issues such as conflicts in Mk files and handling renamed/removed directories.
 contributor/ports/maintaining-ports-tree.md
contributor/ports/index.md
Updated documentation index files to include the new ports documentation.
  • Added a link to the new 'Maintaining GhostBSD Ports from FreeBSD Ports' documentation in the English index file.
  • Added a link to the new 'Maintaining GhostBSD Ports from FreeBSD Ports' documentation in the Polish index file.
 index.md
index-pl.md
Updated the documentation configuration to improve functionality and appearance.
  • Enabled linkify and colon_fence extensions for the myst parser.
  • Added a sidebar to all pages.
  • Added dark mode support for admonitions.
 conf.py
_static/dark_mode.css
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 5, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ericbsd - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief overview or introduction to the ports contribution documentation to set the context for new contributors.
  • In the ports maintenance guide, it might be helpful to include a section on how to handle new ports added in FreeBSD that don't yet exist in GhostBSD.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ericbsd @sourcery-ai
Remove EFE contributor/ports/maintaining-ports-tree.md
04e950f 
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@ericbsd ericbsd merged commit 83e57d6 into master Apr 6, 2025
1 check passed
@ericbsd ericbsd deleted the maintaining-ports branch April 6, 2025 11:22
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Apr 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

Documentation Management
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ericbsd